/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.jet.impl.util;

import com.hazelcast.jet.Traverser;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.function.Function;

/**
 * Same as {@link Traverser}. This traverser can be closed
 *
 * @param <T>
 */
@FunctionalInterface
public interface AutoCloseableTraverser<T> extends Traverser<T>, AutoCloseable {

    /**
     * Same as {{@link #flatMap(Function)}}. The returned traverser will close the internal traverser
     */
    @Nonnull
    @CheckReturnValue
    default <R> AutoCloseableTraverser<R> flatMapAutoCloseable(
            @Nonnull Function<? super T, ? extends AutoCloseableTraverser<R>> flatMapFn) {
        return new FlatMappingAutoCloseableTraverser<>(this, flatMapFn);
    }

    @Override
    default void close() throws Exception {
    }
}
